<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>The SolrPingResponse class</title>
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-base.css" />
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-medium.css" />

 </head>
 <body class="docs"><div class="navbar navbar-fixed-top">
  <div class="navbar-inner clearfix">
    <ul class="nav" style="width: 100%">
      <li style="float: left;"><a href="solrupdateresponse.destruct.html">« SolrUpdateResponse::__destruct</a></li>
      <li style="float: right;"><a href="solrpingresponse.construct.html">SolrPingResponse::__construct »</a></li>
    </ul>
  </div>
</div>
<div id="breadcrumbs" class="clearfix">
  <ul class="breadcrumbs-container">
    <li><a href="index.html">PHP Manual</a></li>
    <li><a href="book.solr.html">Solr</a></li>
    <li>The SolrPingResponse class</li>
  </ul>
</div>
<div id="layout">
  <div id="layout-content"><div id="class.solrpingresponse" class="reference">

 <h1 class="title">The SolrPingResponse class</h1>
 

 <div class="partintro"><p class="verinfo">(PECL solr &gt;= 0.9.2)</p>


  <div class="section" id="solrpingresponse.intro">
   <h2 class="title">简介</h2>
   <p class="para">
    Represents a response to a ping request to the server
   </p>
  </div>


  <div class="section" id="solrpingresponse.synopsis">
   <h2 class="title">类摘要</h2>


   <div class="classsynopsis">
    <div class="ooclass"></div>


    <div class="classsynopsisinfo">
     <span class="ooclass">
      <span class="modifier">final</span>
      <span class="modifier">class</span> <strong class="classname">SolrPingResponse</strong>
     </span>
     
     <span class="ooclass">
      <span class="modifier">extends</span>
       <a href="class.solrresponse.html" class="classname">SolrResponse</a>
     </span>
     {</div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* 常量 */</div>
    <div class="fieldsynopsis">
     <span class="modifier">const</span>
     <span class="type">int</span>
      <var class="fieldsynopsis_varname"><a href="class.solrpingresponse.html#solrpingresponse.constants.parse-solr-obj"><var class="varname">PARSE_SOLR_OBJ</var></a></var><span class="initializer"> = 0</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type">int</span>
      <var class="fieldsynopsis_varname"><a href="class.solrpingresponse.html#solrpingresponse.constants.parse-solr-doc"><var class="varname">PARSE_SOLR_DOC</var></a></var><span class="initializer"> = 1</span>;</div>


    <div class="classsynopsisinfo classsynopsisinfo_comment">/* 属性 */</div>

    
    <div class="classsynopsisinfo classsynopsisinfo_comment">/* 方法 */</div>
    <div class="constructorsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><a href="solrpingresponse.construct.html" class="methodname">__construct</a></span>()</div>

    <div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrpingresponse.getresponse.html" class="methodname">getResponse</a></span>(): <span class="type">string</span></div>

    <div class="destructorsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrpingresponse.destruct.html" class="methodname">__destruct</a></span>()</div>

    
    <div class="classsynopsisinfo classsynopsisinfo_comment">/* 继承的方法 */</div>
    <div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrresponse.getdigestedresponse.html" class="methodname">SolrResponse::getDigestedResponse</a></span>(): <span class="type">string</span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrresponse.gethttpstatus.html" class="methodname">SolrResponse::getHttpStatus</a></span>(): <span class="type">int</span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrresponse.gethttpstatusmessage.html" class="methodname">SolrResponse::getHttpStatusMessage</a></span>(): <span class="type">string</span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrresponse.getrawrequest.html" class="methodname">SolrResponse::getRawRequest</a></span>(): <span class="type">string</span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrresponse.getrawrequestheaders.html" class="methodname">SolrResponse::getRawRequestHeaders</a></span>(): <span class="type">string</span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrresponse.getrawresponse.html" class="methodname">SolrResponse::getRawResponse</a></span>(): <span class="type">string</span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrresponse.getrawresponseheaders.html" class="methodname">SolrResponse::getRawResponseHeaders</a></span>(): <span class="type">string</span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrresponse.getrequesturl.html" class="methodname">SolrResponse::getRequestUrl</a></span>(): <span class="type">string</span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrresponse.getresponse.html" class="methodname">SolrResponse::getResponse</a></span>(): <span class="type"><a href="class.solrobject.html" class="type SolrObject">SolrObject</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrresponse.setparsemode.html" class="methodname">SolrResponse::setParseMode</a></span>(<span class="methodparam"><span class="type">int</span> <code class="parameter">$parser_mode</code><span class="initializer"> = 0</span></span>): <span class="type">bool</span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="solrresponse.success.html" class="methodname">SolrResponse::success</a></span>(): <span class="type">bool</span></div>


   }</div>


  </div>

  

  <div class="section" id="solrpingresponse.props">
   <h2 class="title">属性</h2>
   <dl>
    
     <dt id="solrpingresponse.props.http-status"><var class="varname">http_status</var></dt>

     <dd>

      <p class="para">The http status of the response.</p>
     </dd>

    
    
     <dt id="solrpingresponse.props.parser-mode"><var class="varname">parser_mode</var></dt>

     <dd>

      <p class="para">Whether to parse the solr documents as SolrObject or SolrDocument instances.</p>
     </dd>

    
    
     <dt id="solrpingresponse.props.success"><var class="varname">success</var></dt>

     <dd>

      <p class="para">Was there an error during the request</p>
     </dd>

    
    
     <dt id="solrpingresponse.props.http-status-message"><var class="varname">http_status_message</var></dt>

     <dd>

      <p class="para">Detailed message on http status</p>
     </dd>

    
    
     <dt id="solrpingresponse.props.http-request-url"><var class="varname">http_request_url</var></dt>

     <dd>

      <p class="para">The request URL</p>
     </dd>

    
    
     <dt id="solrpingresponse.props.http-raw-request-headers"><var class="varname">http_raw_request_headers</var></dt>

     <dd>

      <p class="para">A string of raw headers sent during the request</p>
     </dd>

    
    
     <dt id="solrpingresponse.props.http-raw-request"><var class="varname">http_raw_request</var></dt>

     <dd>

      <p class="para">The raw request sent to the server</p>
     </dd>

    
    
     <dt id="solrpingresponse.props.http-raw-response-headers"><var class="varname">http_raw_response_headers</var></dt>

     <dd>

      <p class="para">Response headers from the Solr server</p>
     </dd>

    
    
     <dt id="solrpingresponse.props.http-raw-response"><var class="varname">http_raw_response</var></dt>

     <dd>

      <p class="para">The response message from the server</p>
     </dd>

    
    
     <dt id="solrpingresponse.props.http-digested-response"><var class="varname">http_digested_response</var></dt>

     <dd>

      <p class="para">The response in PHP serialized format.</p>
     </dd>

    
   </dl>

  </div>


  

  <div class="section" id="solrpingresponse.constants">
   <h2 class="title">预定义常量</h2>
   <div class="section" id="solrpingresponse.constants.types">
    <h2 class="title">SolrPingResponse Class Constants</h2>
    <dl>

     
      <dt id="solrpingresponse.constants.parse-solr-obj"><strong><code>SolrPingResponse::PARSE_SOLR_OBJ</code></strong></dt>

      <dd>

       <p class="para">Documents should be parsed as SolrObject instances</p>
      </dd>

     

     
      <dt id="solrpingresponse.constants.parse-solr-doc"><strong><code>SolrPingResponse::PARSE_SOLR_DOC</code></strong></dt>

      <dd>

       <p class="para">Documents should be parsed as SolrDocument instances.</p>
      </dd>

     

    </dl>

   </div>
  </div>



 </div>

 






















<h2>目录</h2><ul class="chunklist chunklist_reference"><li><a href="solrpingresponse.construct.html">SolrPingResponse::__construct</a> — Constructor</li><li><a href="solrpingresponse.destruct.html">SolrPingResponse::__destruct</a> — Destructor</li><li><a href="solrpingresponse.getresponse.html">SolrPingResponse::getResponse</a> — Returns the response from the server</li></ul>
</div>
</div></div></body></html>